Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix more typos in the docs #7225

Merged
merged 9 commits into from
Oct 21, 2021
Merged

Fix more typos in the docs #7225

merged 9 commits into from
Oct 21, 2021

Conversation

lmossman
Copy link
Contributor

What

Fix some more typos I've found in the docs to make them less confusing.

How

Recommended reading order

Pre-merge Checklist

Expand the relevant checklist and delete the others.

New Connector

Community member or Airbyter

  • Community member? Grant edit access to maintainers (instructions)
  • Secrets in the connector's spec are annotated with airbyte_secret
  • Unit & integration tests added and passing. Community members, please provide proof of success locally e.g: screenshot or copy-paste unit, integration, and acceptance test output. To run acceptance tests for a Python connector, follow instructions in the README. For java connectors run ./gradlew :airbyte-integrations:connectors:<name>:integrationTest.
  • Code reviews completed
  • Documentation updated
    • Connector's README.md
    • Connector's bootstrap.md. See description and examples
    • docs/SUMMARY.md
    • docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
    • docs/integrations/README.md
    • airbyte-integrations/builds.md
  • PR name follows PR naming conventions
  • Connector added to connector index like described here

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

  • Create a non-forked branch based on this PR and test the below items on it
  • Build is successful
  • Credentials added to Github CI. Instructions.
  • /test connector=connectors/<name> command is passing.
  • New Connector version released on Dockerhub by running the /publish command described here

Updating a connector

Community member or Airbyter

  • Grant edit access to maintainers (instructions)
  • Secrets in the connector's spec are annotated with airbyte_secret
  • Unit & integration tests added and passing. Community members, please provide proof of success locally e.g: screenshot or copy-paste unit, integration, and acceptance test output. To run acceptance tests for a Python connector, follow instructions in the README. For java connectors run ./gradlew :airbyte-integrations:connectors:<name>:integrationTest.
  • Code reviews completed
  • Documentation updated
    • Connector's README.md
    • Connector's bootstrap.md. See description and examples
    • Changelog updated in docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
  • PR name follows PR naming conventions
  • Connector version bumped like described here

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

  • Create a non-forked branch based on this PR and test the below items on it
  • Build is successful
  • Credentials added to Github CI. Instructions.
  • /test connector=connectors/<name> command is passing.
  • New Connector version released on Dockerhub by running the /publish command described here

Connector Generator

  • Issue acceptance criteria met
  • PR name follows PR naming conventions
  • If adding a new generator, add it to the list of scaffold modules being tested
  • The generator test modules (all connectors with -scaffold in their name) have been updated with the latest scaffold by running ./gradlew :airbyte-integrations:connector-templates:generator:testScaffoldTemplates then checking in your changes
  • Documentation which references the generator is updated as needed.

@github-actions github-actions bot added the area/documentation Improvements or additions to documentation label Oct 20, 2021
@lmossman lmossman temporarily deployed to more-secrets October 20, 2021 21:24 Inactive
@lmossman lmossman temporarily deployed to more-secrets October 20, 2021 21:29 Inactive
@lmossman lmossman temporarily deployed to more-secrets October 20, 2021 21:43 Inactive
@lmossman lmossman temporarily deployed to more-secrets October 20, 2021 21:46 Inactive
@lmossman lmossman temporarily deployed to more-secrets October 20, 2021 21:51 Inactive
@lmossman lmossman temporarily deployed to more-secrets October 20, 2021 21:56 Inactive
@lmossman lmossman temporarily deployed to more-secrets October 20, 2021 22:24 Inactive
@lmossman lmossman temporarily deployed to more-secrets October 20, 2021 23:12 Inactive
@lmossman lmossman temporarily deployed to more-secrets October 20, 2021 23:23 Inactive
lmossman
lmossman commented Oct 20, 2021
View reviewed changes
docs/understanding-airbyte/airbyte-specification.md
@@ -59,7 +59,7 @@ The `read` command will emit a stream records to stdout.
spec() -> ConnectorSpecification
check(Config) -> AirbyteConnectionStatus
discover(Config) -> AirbyteCatalog
read(Config, AirbyteCatalog, State) -> Stream<AirbyteMessage>
read(Config, ConfiguredAirbyteCatalog, State) -> Stream<AirbyteMessage>
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@cgardens to make a similar update to the write side, with information about write outputting State messages

@lmossman lmossman merged commit bd5d4ee into master Oct 21, 2021
@lmossman lmossman deleted the docs-typos branch October 21, 2021 17:08
@cgardens
Copy link
Contributor

thank you!

@jrhizor jrhizor mentioned this pull request Oct 21, 2021
Merged
schlattk pushed a commit to schlattk/airbyte that referenced this pull request Jan 4, 2022
@lmossman @schlattk
Fix more typos in the docs (airbytehq#7225)
0a885d4 
* Fix more typos in the docs

* fix another typo

* add "to"

* make "example" plural

* remove extra words

* add period

* remove extra "the"

* use `source_defined_cursor` instead of `cursor_field` for `AirbyteStream`

* Use ConfiguredAirbyteCatalog instead of AirbyteCatalog
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@benmoriceau benmoriceau benmoriceau approved these changes

Assignees
No one assigned
Labels
area/documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@lmossman @cgardens @benmoriceau